<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: include/trcDiagnostics.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.8.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('trcDiagnostics_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">trcDiagnostics.h</div></div>
</div><!--header-->
<div class="contents">
<a href="trcDiagnostics_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">* Percepio Trace Recorder for Tracealyzer v4.8.0</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">* Copyright 2023 Percepio AB</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">* www.percepio.com</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">*</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment">* SPDX-License-Identifier: Apache-2.0</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment">*/</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="preprocessor">#ifndef TRC_DIAGNOSTICS_H</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="preprocessor">#define TRC_DIAGNOSTICS_H</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="preprocessor">#if (TRC_USE_TRACEALYZER_RECORDER == 1)</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#if (TRC_CFG_RECORDER_MODE == TRC_RECORDER_MODE_STREAMING)</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &lt;trcTypes.h&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#define TRC_DIAGNOSTICS_COUNT 5UL</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="keyword">typedef</span> <span class="keyword">enum</span> TraceDiagnosticsType</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>{</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>    TRC_DIAGNOSTICS_ENTRY_SYMBOL_LONGEST_LENGTH = 0x00UL,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>    TRC_DIAGNOSTICS_ENTRY_SLOTS_NO_ROOM = 0x01UL,</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>    TRC_DIAGNOSTICS_BLOB_MAX_BYTES_TRUNCATED = 0x02UL,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>    TRC_DIAGNOSTICS_STACK_MONITOR_NO_SLOTS = 0x03UL,</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>    TRC_DIAGNOSTICS_ASSERTS_TRIGGERED = 0x04UL,</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>} TraceDiagnosticsType_t;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="keyword">typedef</span> <span class="keyword">struct </span>TraceDiagnostics <span class="comment">/* Aligned */</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>{</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>    TraceBaseType_t metrics[TRC_DIAGNOSTICS_COUNT];</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>} TraceDiagnosticsData_t;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>traceResult xTraceDiagnosticsInitialize(TraceDiagnosticsData_t* pxBuffer);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>traceResult <a class="code hl_function" href="trcDiagnostics_8h.html#af9e5f44c6191e70fc32c79d91e28c83f">xTraceDiagnosticsGet</a>(TraceDiagnosticsType_t xType, TraceBaseType_t* pxValue);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>traceResult <a class="code hl_function" href="trcDiagnostics_8h.html#a8663f02f7a5a11b623a3182ce0464909">xTraceDiagnosticsSet</a>(TraceDiagnosticsType_t xType, TraceBaseType_t xValue);</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span>traceResult <a class="code hl_function" href="trcDiagnostics_8h.html#a21f4cdae7b41b361b99242e927a36ca3">xTraceDiagnosticsAdd</a>(TraceDiagnosticsType_t xType, TraceBaseType_t xValue);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>traceResult <a class="code hl_function" href="trcDiagnostics_8h.html#a3a487dce9e02c0ac1a6ec842ea971875">xTraceDiagnosticsIncrease</a>(TraceDiagnosticsType_t xType);</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>traceResult <a class="code hl_function" href="trcDiagnostics_8h.html#a645f1442aad45717d66f694b9d644463">xTraceDiagnosticsDecrease</a>(TraceDiagnosticsType_t xType);</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>traceResult <a class="code hl_function" href="trcDiagnostics_8h.html#ae9e17847a7689d40a59e9a930e2a8af9">xTraceDiagnosticsSetIfHigher</a>(TraceDiagnosticsType_t xType, TraceBaseType_t xValue);</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span>traceResult <a class="code hl_function" href="trcDiagnostics_8h.html#a69fe97dcb698c1866c0d9d5566b0669d">xTraceDiagnosticsSetIfLower</a>(TraceDiagnosticsType_t xType, TraceBaseType_t xValue);</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span> </div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span>traceResult <a class="code hl_function" href="trcDiagnostics_8h.html#ac2afded938b5e72ced2f7d7096aeed49">xTraceDiagnosticsCheckStatus</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span> </div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>}</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="preprocessor">#endif </span><span class="comment">/* (TRC_CFG_RECORDER_MODE == TRC_RECORDER_MODE_STREAMING) */</span><span class="preprocessor"></span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span> </div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="preprocessor">#endif </span><span class="comment">/* (TRC_USE_TRACEALYZER_RECORDER == 1) */</span><span class="preprocessor"></span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span> </div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="preprocessor">#endif </span><span class="comment">/* TRC_DIAGNOSTICS_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="atrcDiagnostics_8h_html_a21f4cdae7b41b361b99242e927a36ca3"><div class="ttname"><a href="trcDiagnostics_8h.html#a21f4cdae7b41b361b99242e927a36ca3">xTraceDiagnosticsAdd</a></div><div class="ttdeci">traceResult xTraceDiagnosticsAdd(TraceDiagnosticsType_t xType, TraceBaseType_t xValue)</div><div class="ttdoc">Add to diagnostics value.</div><div class="ttdef"><b>Definition:</b> trcDiagnostics.c:67</div></div>
<div class="ttc" id="atrcDiagnostics_8h_html_a3a487dce9e02c0ac1a6ec842ea971875"><div class="ttname"><a href="trcDiagnostics_8h.html#a3a487dce9e02c0ac1a6ec842ea971875">xTraceDiagnosticsIncrease</a></div><div class="ttdeci">traceResult xTraceDiagnosticsIncrease(TraceDiagnosticsType_t xType)</div><div class="ttdoc">Increase diagnostics value.</div><div class="ttdef"><b>Definition:</b> trcDiagnostics.c:80</div></div>
<div class="ttc" id="atrcDiagnostics_8h_html_a645f1442aad45717d66f694b9d644463"><div class="ttname"><a href="trcDiagnostics_8h.html#a645f1442aad45717d66f694b9d644463">xTraceDiagnosticsDecrease</a></div><div class="ttdeci">traceResult xTraceDiagnosticsDecrease(TraceDiagnosticsType_t xType)</div><div class="ttdoc">Decrease diagnostics value.</div><div class="ttdef"><b>Definition:</b> trcDiagnostics.c:85</div></div>
<div class="ttc" id="atrcDiagnostics_8h_html_a69fe97dcb698c1866c0d9d5566b0669d"><div class="ttname"><a href="trcDiagnostics_8h.html#a69fe97dcb698c1866c0d9d5566b0669d">xTraceDiagnosticsSetIfLower</a></div><div class="ttdeci">traceResult xTraceDiagnosticsSetIfLower(TraceDiagnosticsType_t xType, TraceBaseType_t xValue)</div><div class="ttdoc">Set a new diagnostics value if lower than previous value.</div><div class="ttdef"><b>Definition:</b> trcDiagnostics.c:106</div></div>
<div class="ttc" id="atrcDiagnostics_8h_html_a8663f02f7a5a11b623a3182ce0464909"><div class="ttname"><a href="trcDiagnostics_8h.html#a8663f02f7a5a11b623a3182ce0464909">xTraceDiagnosticsSet</a></div><div class="ttdeci">traceResult xTraceDiagnosticsSet(TraceDiagnosticsType_t xType, TraceBaseType_t xValue)</div><div class="ttdoc">Set diagnostics value.</div><div class="ttdef"><b>Definition:</b> trcDiagnostics.c:54</div></div>
<div class="ttc" id="atrcDiagnostics_8h_html_ac2afded938b5e72ced2f7d7096aeed49"><div class="ttname"><a href="trcDiagnostics_8h.html#ac2afded938b5e72ced2f7d7096aeed49">xTraceDiagnosticsCheckStatus</a></div><div class="ttdeci">traceResult xTraceDiagnosticsCheckStatus(void)</div><div class="ttdoc">Check the diagnostics status.</div><div class="ttdef"><b>Definition:</b> trcDiagnostics.c:122</div></div>
<div class="ttc" id="atrcDiagnostics_8h_html_ae9e17847a7689d40a59e9a930e2a8af9"><div class="ttname"><a href="trcDiagnostics_8h.html#ae9e17847a7689d40a59e9a930e2a8af9">xTraceDiagnosticsSetIfHigher</a></div><div class="ttdeci">traceResult xTraceDiagnosticsSetIfHigher(TraceDiagnosticsType_t xType, TraceBaseType_t xValue)</div><div class="ttdoc">Set a new diagnostics value if higher than previous value.</div><div class="ttdef"><b>Definition:</b> trcDiagnostics.c:90</div></div>
<div class="ttc" id="atrcDiagnostics_8h_html_af9e5f44c6191e70fc32c79d91e28c83f"><div class="ttname"><a href="trcDiagnostics_8h.html#af9e5f44c6191e70fc32c79d91e28c83f">xTraceDiagnosticsGet</a></div><div class="ttdeci">traceResult xTraceDiagnosticsGet(TraceDiagnosticsType_t xType, TraceBaseType_t *pxValue)</div><div class="ttdoc">Retrieve diagnostics value.</div><div class="ttdef"><b>Definition:</b> trcDiagnostics.c:38</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="trcDiagnostics_8h.html">trcDiagnostics.h</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
